home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / os2 / octa209s.zip / octave-2.09 / src / help.h < prev    next >
C/C++ Source or Header  |  1996-05-15  |  2KB  |  67 lines
  1. /*
  2.  
  3. Copyright (C) 1996 John W. Eaton
  4.  
  5. This file is part of Octave.
  6.  
  7. Octave is free software; you can redistribute it and/or modify it
  8. under the terms of the GNU General Public License as published by the
  9. Free Software Foundation; either version 2, or (at your option) any
  10. later version.
  11.  
  12. Octave is distributed in the hope that it will be useful, but WITHOUT
  13. ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14. FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15. for more details.
  16.  
  17. You should have received a copy of the GNU General Public License
  18. along with Octave; see the file COPYING.  If not, write to the Free
  19. Software Foundation, 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20.  
  21. */
  22.  
  23. #if !defined (octave_help_h)
  24. #define octave_help_h 1
  25.  
  26. class ostrstream;
  27.  
  28. #include <string>
  29.  
  30. class string_vector;
  31.  
  32. // XXX FIXME XXX -- should probably use string, not char*.
  33.  
  34. struct help_list
  35. {
  36.   char *name;
  37.   char *help;
  38. };
  39.  
  40. extern string_vector names (help_list *l, int& count);
  41. extern help_list *operator_help (void);
  42. extern help_list *keyword_help (void);
  43.  
  44. extern void print_usage (const string& nm, int just_usage = 0);
  45.  
  46. extern int help_from_list (ostrstream& output_buf,
  47.                const help_list *list, const string& nm,
  48.                int usage);
  49.  
  50. // Name of the info file specified on command line.
  51. // (--info-file file)
  52. extern string Vinfo_file;
  53.  
  54. // Name of the info reader we'd like to use.
  55. // (--info-program program)
  56. extern string Vinfo_prog;
  57.  
  58. extern void symbols_of_help (void);
  59.  
  60. #endif
  61.  
  62. /*
  63. ;;; Local Variables: ***
  64. ;;; mode: C++ ***
  65. ;;; End: ***
  66. */
  67.